/********************************************************************************
 * Copyright 2009 The Robotics Group, The Maersk Mc-Kinney Moller Institute,
 * Faculty of Engineering, University of Southern Denmark
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ********************************************************************************/

#ifndef RW_GRAPHICS_RENDER_HPP
#define RW_GRAPHICS_RENDER_HPP

/**
 * @file Render.hpp
 */
#if !defined(SWIG)
#include <rw/graphics/DrawableNode.hpp>

#include <rw/core/Ptr.hpp>
#endif 

namespace rw { namespace graphics {

    /** @addtogroup graphics */
    /*@{*/

    /**
     * @brief Abstract base class for all renderable classes
     *
     * Classes that are able to render them self, may inherit from this class.
     */
    class Render
    {
      public:
        //! @brief smart pointer type to this class
        typedef rw::core::Ptr< Render > Ptr;

        /**
         * @brief when calling render on the draw mode or type
         * can be specified. See DrawableNode::DrawType
         */
        typedef DrawableNode::DrawType DrawType;

        /**
         * @brief destructor
         */
        virtual ~Render (){};

        /**
         * @brief draws the object.
         * @param info [in] state and rendering specific info
         * @param type [in] the drawtype which is being used
         * @param alpha [in] the alpha value to render with
         */
        virtual void draw (const DrawableNode::RenderInfo& info, DrawableNode::DrawType type,
                           double alpha) const = 0;

      protected:
        //! @brief Only instances of classes inheriting Render is allowed
        Render (){};

      private:
        Render (const Render&);
        Render& operator= (const Render&);
    };
    //! smart pointer type
    typedef rw::core::Ptr< Render > RenderPtr;

    /*@}*/
}}    // namespace rw::graphics

#endif    // end include guard
